Обновление данных сотрудника (PATCH)

Запрос позволяет обновить информацию о сотруднике клиента. Есть аналогичный метод PUT.

Примечание

Крайне не рекомендуется менять номер телефона сотрудника. Вместо этого лучше создать нового сотрудника.

Синтаксис запроса

PATCH https://b2b-api.go.yandex.ru/integration/2.0/users?user_id={идентификатор пользователя}

Заголовки запроса

Authorization: Bearer <OAuth-токен>
Процесс получения токена описан в разделе Начало работы.

X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос содержит обязательный параметр:

user_id — идентификатор сотрудника, по которому обновляется информация.

Тело запроса

Данные о сотруднике передаются в теле запроса в формате JSON:

Поле	Описание	Формат	Обязательность
`fullname`	Полное имя сотрудника. Может быть пустой строкой.	Строка	Нет
`phone`	Телефонный номер сотрудника.	Строка	Нет
`email`	Адрес электронной почты пользователя. Можно указать только email, который соответствует стандартному формату адреса.	Строка	Нет
`is_active`	Признак активности сотрудника. Неактивный сотрудник не имеет возможности самостоятельного заказа и на его имя нельзя заказать поездку.	Логическое	Нет
`cost_centers_id`	id набора настроек центров затрат. Если не включать поле в запрос, сотруднику будет назначен основной центр затрат (при наличии у клиента новых центров затрат).	Строка	Нет
`is_deleted`	Признак архивированного сотрудника.	Логическое	Нет
`nickname`	Краткое имя сотрудника. В интерфейсе личного кабинета является полем ID во внешней системе.	Строка	Нет
`department_id`	Идентификатор департамента в личном кабинете.	Строка	Нет
`limits`	Ограничения на сумму, которую пользователь может потратить на определенный сервис за календарный месяц.	Массив элементов, содержит отдельный элемент для каждого сервиса.	Нет

Структура элемента массива limits:

Поле

Описание

Формат

Обязательность

limit_id

Идентификатор ранее созданного лимита, который будет назначен пользователю.

Строка

Да

service

Название сервиса. Возможные значения:

taxi: Яндекс Go;
eats2: Яндекс Еда и Яндекс Лавка;
grocery: Яндекс Лавка;
drive: Каршеринг;
tanker: Яндекс Заправки;
cargo: Грузоперевозки;
travel: Яндекс Путешествия;
scooters: Яндекс Самокаты.

Строка

Да

Описание полей ответа

Ответ содержит поле:

Поле	Описание	Формат
`status`	В случае успешного выполнения запроса возвращается статус ОК.	Строка

Пример запроса

PATCH https://b2b-api.go.yandex.ru/integration/2.0/users?user_id=f65...c57d
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

    {
        "fullname": "Иванов Илья",
        "phone": "+79990000000",
        "is_active": true,
        "nickname": "ИИлья",
        "cost_centers_id": "123...fef",
        "department_id": "987...ghj",        
        "limits":[
            { 
                "limit_id": "abcdef_taxi",
                "service": "taxi" 
            },
            {
                "limit_id":"abcdef_eats",
                "service":"eats2"
            },
            {
                "limit_id":"abcdef_drive",
                "service":"drive"
            }
        ]   
     }

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
    "status": "OK"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

200 — запрос выполнен успешно.
400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением.
401 — был передан неверный OAuth-токен.
403 — у клиента не хватает прав на выполнение данного запроса:
- SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
- SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
404 — запрашиваемая запись не найдена.

Была ли статья полезна?

Обновление данных сотрудника (PUT)

Архивирование сотрудника